home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / ArchiveUtils / Unarj / unarj.h < prev    next >
C/C++ Source or Header  |  1993-01-08  |  12KB  |  415 lines
  1. /* UNARJ.H, UNARJ, R JUNG, 12/03/91
  2.  * Include file
  3.  * Copyright (c) 1990 by Robert K Jung.  All rights reserved.
  4.  *
  5.  *   This code may be freely used in programs that are NOT ARJ archivers
  6.  *   (both compress and extract ARJ archives).
  7.  *
  8.  *   If you wish to distribute a modified version of this program, you
  9.  *   MUST indicate that it is a modified version both in the program and
  10.  *   source code.
  11.  *
  12.  *   If you modify this program, I would appreciate a copy of the new
  13.  *   source code.  I am holding the copyright on the source code, so
  14.  *   please do not delete my name from the program files or from the
  15.  *   documentation.
  16.  *
  17.  * Modification history:
  18.  * Date      Programmer  Description of modification.
  19.  * 04/05/91  R. Jung     Rewrote code.
  20.  * 04/23/91  M. Adler    Portabilized.
  21.  * 04/29/91  R. Jung     Added volume label support.
  22.  * 05/30/91  R. Jung     Added SEEK_END definition.
  23.  * 06/03/91  R. Jung     Changed arguments in get_mode_str() and
  24.  *                       set_ftime_mode().
  25.  * 06/28/91  R. Jung     Added new HOST OS numbers.
  26.  * 07/08/91  R. Jung     Added default_case_path() and strlower().
  27.  * 07/21/91  R. Jung     Fixed #endif _QC comment.
  28.  * 08/27/91  R. Jung     Added #ifdef for COHERENT.
  29.  * 09/01/91  R. Jung     Added new host names.
  30.  * 12/03/91  R. Jung     Added BACKUP_FLAG.
  31.  *
  32.  */
  33.  
  34. #ifndef _ARH_DEF_
  35. #define _ARH_DEF_
  36.  
  37. /* Use prototypes and ANSI libraries if __STDC__ */
  38. #ifdef __STDC__
  39. #  define MODERN
  40. #endif /* __STDC__ */
  41.  
  42. /* Do not use prototypes for COHERENT */
  43. #ifdef COHERENT
  44. #  undef  MODERN
  45. #  define KEEP_WINDOW
  46. #endif /* COHERENT */
  47.  
  48. /* Use prototypes and ANSI libraries if __TURBOC__ */
  49. #ifdef __TURBOC__
  50. #  define MODERN
  51. #endif /* __TURBOC__ */
  52.  
  53. /* Use prototypes and ANSI libraries if _QC */
  54. #ifdef _QC
  55. #  define MODERN
  56. #endif /* _QC */
  57.  
  58. /* Use prototypes and ANSI libraries if _OS2 */
  59. #ifdef _OS2
  60. #  define MODERN
  61. #endif /* _OS2 */
  62.  
  63. /* Use prototypes and ANSI libraries if _NeXT */
  64. #ifdef _NeXT
  65. #  define MODERN
  66. #endif /* _NeXT */
  67.  
  68. /* Used to remove arguments in function prototypes for non-ANSI C */
  69. #ifdef MODERN
  70. #  define OF(a) a
  71. #else /* !MODERN */
  72. #  define OF(a) ()
  73. #endif /* ?MODERN */
  74.  
  75. #ifdef MODERN
  76.    typedef void voidp;
  77. #else /* !MODERN */
  78. #  define void int
  79.    typedef char voidp;
  80. #endif /* ?MODERN */
  81.  
  82. #include <stdio.h>
  83. #ifdef MODERN
  84. #  include <limits.h>
  85. #else /* !MODERN */
  86. #  ifndef UCHAR_MAX
  87. #    define UCHAR_MAX (255)
  88. #  endif
  89. #  ifndef CHAR_BIT
  90. #    define CHAR_BIT  (8)
  91. #  endif
  92. #  ifndef LONG_MAX
  93. #    define LONG_MAX  (0x7FFFFFFFL)
  94. #  endif
  95. #endif /* ?MODERN */
  96.  
  97. #ifndef SEEK_SET
  98. #  define SEEK_SET 0
  99. #endif
  100.  
  101. #ifndef SEEK_CUR
  102. #  define SEEK_CUR 1
  103. #endif
  104.  
  105. #ifndef SEEK_END
  106. #  define SEEK_END 2
  107. #endif
  108.  
  109. typedef unsigned char  uchar;   /*  8 bits or more */
  110. typedef unsigned int   uint;    /* 16 - 32 bits or more */
  111. typedef unsigned short ushort;  /* 16 bits or more */
  112. typedef unsigned long  ulong;   /* 32 bits or more */
  113.  
  114. #define USHRT_BIT   (CHAR_BIT * sizeof(ushort))
  115.  
  116. /* ********************************************************* */
  117. /* Environment definitions (implementation dependent)        */
  118. /* ********************************************************* */
  119.  
  120. #ifdef _QC
  121. #define __MSDOS__
  122. #endif
  123.  
  124. #ifdef __MSDOS__
  125. #define OS                  0
  126. #define PATH_SEPARATORS     "\\:"
  127. #define PATH_CHAR           '\\'
  128. #define MAXSFX              25000L
  129. #define ARJ_SUFFIX          ".ARJ"
  130. #endif
  131.  
  132. #ifdef _OS2
  133. #define OS                  0           /* ??? */
  134. #define PATH_SEPARATORS     "\\:"
  135. #define PATH_CHAR           '\\'
  136. #define SWITCH_CHARS        "-/"
  137. #define MAXSFX              25000L
  138. #define ARJ_SUFFIX          ".ARJ"
  139. #endif
  140.  
  141. #ifdef _NeXT
  142. #define OS                  8           /* NeXT */
  143. #define PATH_SEPARATORS     "/"
  144. #define PATH_CHAR           '/'
  145. #define SWITCH_CHARS        "-"
  146. #define FNAME_MAX           1024
  147. #define MAXSFX              500000L
  148. #define ARJ_SUFFIX          ".arj"
  149. #endif
  150.  
  151. #ifdef __CI
  152. #define PRIME               1
  153. #define OS                  1
  154. #define PATH_SEPARATORS     ">"
  155. #define PATH_CHAR           '>'
  156. #define FIX_PARITY(c)       c |= ~ASCII_MASK
  157. #define DEFAULT_DIR         "*>"
  158. #define ARJ_SUFFIX          ".ARJ"
  159. #endif
  160.  
  161. /* Error levels */
  162.  
  163. #ifndef ERROR_DEFINES
  164.  
  165. #define ERROR_OK        0       /* success */
  166. #define ERROR_WARN      1       /* minor problem (file not found) */
  167. #define ERROR_FAIL      2       /* fatal error */
  168. #define ERROR_CRC       3       /* CRC error */
  169. #define ERROR_SECURE    4       /* ARJ security invalid or not found */
  170. #define ERROR_WRITE     5       /* disk full */
  171. #define ERROR_OPEN      6       /* can't open file */
  172. #define ERROR_USER      7       /* user specified bad parameters */
  173. #define ERROR_MEMORY    8       /* not enough memory */
  174.  
  175. #endif
  176.  
  177. #ifndef MAXSFX              /* size of self-extracting prefix */
  178. #define MAXSFX              500000L
  179. #endif
  180. #ifndef FNAME_MAX
  181. #define FNAME_MAX           512
  182. #endif
  183. #ifndef SWITCH_CHARS
  184. #define SWITCH_CHARS        "-"
  185. #endif
  186. #ifndef FIX_PARITY
  187. #define FIX_PARITY(c)       c &= ASCII_MASK
  188. #endif
  189. #ifndef ARJ_SUFFIX
  190. #define ARJ_SUFFIX          ".arj"
  191. #endif
  192. #ifndef ARJ_DOT
  193. #define ARJ_DOT             '.'
  194. #endif
  195. #ifndef DEFAULT_DIR
  196. #define DEFAULT_DIR         ""
  197. #endif
  198. #ifndef OS
  199. #define OS                  2
  200. #endif
  201. #ifndef PATH_SEPARATORS
  202. #define PATH_SEPARATORS     "/"
  203. #endif
  204. #ifndef PATH_CHAR
  205. #define PATH_CHAR           '/'
  206. #endif
  207.  
  208. /* ********************************************************* */
  209. /* end of environmental defines                              */
  210. /* ********************************************************* */
  211.  
  212. /* ********************************************************* */
  213. /*
  214.  * Structure of archive block (low order byte first):
  215.  *
  216.  *  2  header id (comment and local file) = 0xEA60 or 60000U
  217.  *  2  basic header size (from 'first_hdr_size' thru 'comment' below)
  218.  *           = first_hdr_size + strlen(filename) + 1 + strlen(comment) + 1
  219.  *           = 0 if end of archive
  220.  *
  221.  *  1  first_hdr_size (size up to 'extra data')
  222.  *  1  archiver version number
  223.  *  1  minimum archiver version to extract
  224.  *  1  host OS   (0 = MSDOS, 1 = PRIMOS, 2 = UNIX, 3 = AMIGA, 4 = MAC-OS)
  225.  *               (5 = OS/2, 6 = APPLE GS, 7 = ATARI ST, 8 = NEXT)
  226.  *               (9 = VAX VMS)
  227.  *  1  arj flags (0x01 = GARBLED_FLAG, 0x02 = RESERVED)
  228.  *               (0x04 = VOLUME_FLAG,  0x08 = EXTFILE_FLAG)
  229.  *               (0x10 = PATHSYM_FLAG, 0x20 = BACKUP_FLAG)
  230.  *  1  method    (0 = stored, 1 = compressed most ... 4 compressed fastest)
  231.  *  1  file type (0 = binary, 1 = text, 2 = comment header)
  232.  *               (3 = directory, 4 = volume label)
  233.  *  1  reserved
  234.  *  4  date time stamp modified
  235.  *  4  compressed size
  236.  *  4  original size
  237.  *  4  original file's CRC
  238.  *  2  entryname position in filename
  239.  *  2  file access mode
  240.  *  2  host data
  241.  *  ?  extra data
  242.  *     4 bytes for extended file position
  243.  *
  244.  *  ?  filename (null-terminated)
  245.  *  ?  comment  (null-terminated)
  246.  *
  247.  *  4  basic header CRC
  248.  *
  249.  *  2  1st extended header size (0 if none)
  250.  *  ?  1st extended header
  251.  *  4  1st extended header's CRC (not present if 0 extended header size)
  252.  *  ...
  253.  *  ?  compressed file
  254.  *
  255.  * ********************************************************* */
  256.  
  257. /* ********************************************************* */
  258. /*                                                           */
  259. /*     Time stamp format:                                    */
  260. /*                                                           */
  261. /*      31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16      */
  262. /*     |<---- year-1980 --->|<- month ->|<--- day ---->|     */
  263. /*                                                           */
  264. /*      15 14 13 12 11 10  9  8  7  6  5  4  3  2  1  0      */
  265. /*     |<--- hour --->|<---- minute --->|<- second/2 ->|     */
  266. /*                                                           */
  267. /* ********************************************************* */
  268.  
  269. #define CODE_BIT          16
  270.  
  271. #define NULL_CHAR       '\0'
  272. #define MAXMETHOD          4
  273.  
  274. #define ARJ_VERSION        3
  275. #define ARJ_X_VERSION      3    /* decoder version */
  276. #define ARJ_X1_VERSION     1
  277. #define DEFAULT_METHOD     1
  278. #define DEFAULT_TYPE       0    /* if type_sw is selected */
  279. #define HEADER_ID     0xEA60
  280. #define HEADER_ID_HI    0xEA
  281. #define HEADER_ID_LO    0x60
  282. #define FIRST_HDR_SIZE    30
  283. #define FIRST_HDR_SIZE_V  34
  284. #define COMMENT_MAX     2048
  285. #define HEADERSIZE_MAX   (FIRST_HDR_SIZE + 10 + FNAME_MAX + COMMENT_MAX)
  286. #define BINARY_TYPE        0    /* This must line up with binary/text strings */
  287. #define TEXT_TYPE          1
  288. #define COMMENT_TYPE       2
  289. #define DIR_TYPE           3
  290. #define LABEL_TYPE         4
  291.  
  292. #define GARBLE_FLAG     0x01
  293. #define VOLUME_FLAG     0x04
  294. #define EXTFILE_FLAG    0x08
  295. #define PATHSYM_FLAG    0x10
  296. #define BACKUP_FLAG     0x20
  297.  
  298. typedef ulong UCRC;     /* CRC-32 */
  299.  
  300. #define CRC_MASK        0xFFFFFFFFL
  301.  
  302. #define ARJ_PATH_CHAR   '/'
  303.  
  304. #define FA_RDONLY       0x01            /* Read only attribute */
  305. #define FA_HIDDEN       0x02            /* Hidden file */
  306. #define FA_SYSTEM       0x04            /* System file */
  307. #define FA_LABEL        0x08            /* Volume label */
  308. #define FA_DIREC        0x10            /* Directory */
  309. #define FA_ARCH         0x20            /* Archive */
  310.  
  311. #define HOST_OS_NAMES1 "MS-DOS","PRIMOS","UNIX","AMIGA","MAC-OS","OS/2"
  312. #define HOST_OS_NAMES2 "APPLE GS","ATARI ST","NEXT","VAX VMS"
  313. #define HOST_OS_NAMES  { HOST_OS_NAMES1, HOST_OS_NAMES2, NULL }
  314.  
  315. /* Timestamp macros */
  316.  
  317. #define get_tx(m,d,h,n) (((ulong)m<<21)+((ulong)d<<16)+((ulong)h<<11)+(n<<5))
  318. #define get_tstamp(y,m,d,h,n,s) ((((ulong)(y-1980))<<25)+get_tx(m,d,h,n)+(s/2))
  319.  
  320. #define ts_year(ts)  ((uint)((ts >> 25) & 0x7f) + 1980)
  321. #define ts_month(ts) ((uint)(ts >> 21) & 0x0f)      /* 1..12 means Jan..Dec */
  322. #define ts_day(ts)   ((uint)(ts >> 16) & 0x1f)      /* 1..31 means 1st..31st */
  323. #define ts_hour(ts)  ((uint)(ts >> 11) & 0x1f)
  324. #define ts_min(ts)   ((uint)(ts >> 5) & 0x3f)
  325. #define ts_sec(ts)   ((uint)((ts & 0x1f) * 2))
  326.  
  327. /* unarj.c */
  328.  
  329. extern long origsize;
  330. extern long compsize;
  331.  
  332. extern UCRC crc;
  333.  
  334. extern FILE *arcfile;
  335. extern FILE *outfile;
  336.  
  337. extern ushort bitbuf;
  338.  
  339. extern uchar subbitbuf;
  340. extern uchar header[HEADERSIZE_MAX];
  341.  
  342. extern char arc_name[FNAME_MAX];
  343.  
  344. extern int bitcount;
  345. extern int file_type;
  346. extern int error_count;
  347.  
  348. /* Global functions */
  349.  
  350. /* unarj.c */
  351.  
  352. void   strlower OF((char *str));
  353. void   strupper OF((char *str));
  354. voidp  *malloc_msg OF((int size));
  355. void   disp_clock OF((void));
  356. void   error OF((char *fmt, char *arg));
  357. void   fillbuf OF((int n));
  358. ushort getbits OF((int n));
  359. void   fwrite_txt_crc OF((uchar *p, int n));
  360. void   init_getbits OF((void));
  361.  
  362. /* environ.c */
  363.  
  364. FILE   *file_open OF((char *name, char *mode));
  365. int    file_read OF((char *buf, int size, int nitems, FILE *stream));
  366. int    file_seek OF((FILE *stream, long offset, int mode));
  367. long   file_tell OF((FILE *stream));
  368. int    file_write OF((char *buf, int size, int nitems, FILE *stream));
  369. voidp  *xmalloc OF((int size));
  370. void   case_path OF((char *name));
  371. void   default_case_path OF((char *name));
  372. int    file_exists OF((char *name));
  373. void   get_mode_str OF((char *str, uint fmode));
  374. int    set_ftime_mode OF((char *name, ulong timestamp, uint fmode, uint host));
  375.  
  376. /* decode.c */
  377.  
  378. void   decode OF((void));
  379. void   decode_f OF((void));
  380.  
  381. /* Message strings */
  382.  
  383. extern char M_VERSION [];
  384.  
  385. extern char M_ARCDATE [];
  386. extern char M_BADCOMND[];
  387. extern char M_BADCOMNT[];
  388. extern char M_BADHEADR[];
  389. extern char M_BADTABLE[];
  390. extern char M_CANTOPEN[];
  391. extern char M_CANTREAD[];
  392. extern char M_CANTWRIT[];
  393. extern char M_CRCERROR[];
  394. extern char M_CRCOK   [];
  395. extern char M_DIFFHOST[];
  396. extern char M_ENCRYPT [];
  397. extern char M_ERRORCNT[];
  398. extern char M_EXTRACT [];
  399. extern char M_FEXISTS [];
  400. extern char M_HEADRCRC[];
  401. extern char M_NBRFILES[];
  402. extern char M_NOMEMORY[];
  403. extern char M_NOTARJ  [];
  404. extern char M_PROCARC [];
  405. extern char M_SKIPPED [];
  406. extern char M_SUFFIX  [];
  407. extern char M_TESTING [];
  408. extern char M_UNKNMETH[];
  409. extern char M_UNKNTYPE[];
  410. extern char M_UNKNVERS[];
  411.  
  412. #endif
  413.  
  414. /* end UNARJ.H */
  415.